home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 October: Mac OS SDK / Dev.CD Oct 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / AppleGuide.p < prev    next >
Encoding:
Text File  |  1997-08-12  |  9.7 KB  |  378 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        AppleGuide.p
  3.  
  4.      Contains:    Apple Guide Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0.1
  8.  
  9.      Copyright:    ©1994-1997 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT AppleGuide;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __APPLEGUIDE__}
  28. {$SETC __APPLEGUIDE__ := 1}
  29.  
  30. {$I+}
  31. {$SETC AppleGuideIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __APPLEEVENTS__}
  38. {$I AppleEvents.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __FILES__}
  41. {$I Files.p}
  42. {$ENDC}
  43.  
  44.  
  45.  
  46. {$PUSH}
  47. {$ALIGN MAC68K}
  48. {$LibExport+}
  49.  
  50. {  Types }
  51.  
  52. TYPE
  53.     AGRefNum                            = UInt32;
  54.     AGCoachRefNum                        = UInt32;
  55.     AGContextRefNum                        = UInt32;
  56.     AGAppInfoPtr = ^AGAppInfo;
  57.     AGAppInfo = RECORD
  58.         eventId:                AEEventID;
  59.         refCon:                    LONGINT;
  60.         contextObj:                Ptr;                                    {  private system field }
  61.     END;
  62.  
  63.     AGAppInfoHdl                        = ^AGAppInfoPtr;
  64.     CoachReplyProcPtr = ProcPtr;  { FUNCTION CoachReply(VAR pRect: Rect; name: Ptr; refCon: LONGINT): OSErr; }
  65.  
  66.     ContextReplyProcPtr = ProcPtr;  { FUNCTION ContextReply(pInputData: Ptr; inputDataSize: Size; VAR ppOutputData: Ptr; VAR pOutputDataSize: Size; hAppInfo: AGAppInfoHdl): OSErr; }
  67.  
  68.     CoachReplyUPP = UniversalProcPtr;
  69.     ContextReplyUPP = UniversalProcPtr;
  70.  
  71. CONST
  72.     uppCoachReplyProcInfo = $00000FE0;
  73.     uppContextReplyProcInfo = $0000FFE0;
  74.  
  75. FUNCTION NewCoachReplyProc(userRoutine: CoachReplyProcPtr): CoachReplyUPP;
  76.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  77.     INLINE $2E9F;
  78.     {$ENDC}
  79.  
  80. FUNCTION NewContextReplyProc(userRoutine: ContextReplyProcPtr): ContextReplyUPP;
  81.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  82.     INLINE $2E9F;
  83.     {$ENDC}
  84.  
  85. FUNCTION CallCoachReplyProc(VAR pRect: Rect; name: Ptr; refCon: LONGINT; userRoutine: CoachReplyUPP): OSErr;
  86.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  87.     INLINE $205F, $4E90;
  88.     {$ENDC}
  89.  
  90. FUNCTION CallContextReplyProc(pInputData: Ptr; inputDataSize: Size; VAR ppOutputData: Ptr; VAR pOutputDataSize: Size; hAppInfo: AGAppInfoHdl; userRoutine: ContextReplyUPP): OSErr;
  91.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  92.     INLINE $205F, $4E90;
  93.     {$ENDC}
  94. {  Constants }
  95.  
  96.  
  97.  
  98. CONST
  99.     kAGDefault                    = 0;
  100.     kAGFrontDatabase            = 1;
  101.     kAGNoMixin                    = -1;
  102.  
  103.  
  104.     kAGViewFullHowdy            = 1;                            {  Full-size Howdy }
  105.     kAGViewTopicAreas            = 2;                            {  Full-size Topic Areas }
  106.     kAGViewIndex                = 3;                            {  Full-size Index Terms }
  107.     kAGViewLookFor                = 4;                            {  Full-size Look-For (Search) }
  108.     kAGViewSingleHowdy            = 5;                            {  Single-list-size Howdy }
  109.     kAGViewSingleTopics            = 6;                            {  Single-list-size Topics }
  110.  
  111.  
  112.     kAGFileMain                    = 'poco';
  113.     kAGFileMixin                = 'mixn';
  114.  
  115. {  To test against AGGetAvailableDBTypes }
  116.     kAGDBTypeBitAny                = $00000001;
  117.     kAGDBTypeBitHelp            = $00000002;
  118.     kAGDBTypeBitTutorial        = $00000004;
  119.     kAGDBTypeBitShortcuts        = $00000008;
  120.     kAGDBTypeBitAbout            = $00000010;
  121.     kAGDBTypeBitOther            = $00000080;
  122.  
  123.  
  124.  
  125. TYPE
  126.     AGStatus                            = UInt16;
  127. {  Returned by AGGetStatus }
  128.  
  129. CONST
  130.     kAGIsNotRunning                = 0;
  131.     kAGIsSleeping                = 1;
  132.     kAGIsActive                    = 2;
  133.  
  134.  
  135.  
  136. TYPE
  137.     AGWindowKind                        = UInt16;
  138. {  Returned by AGGetFrontWindowKind }
  139.  
  140. CONST
  141.     kAGNoWindow                    = 0;
  142.     kAGAccessWindow                = 1;
  143.     kAGPresentationWindow        = 2;
  144.  
  145. {  Error Codes }
  146.  
  147. {  Not an enum, because other OSErrs are valid. }
  148.  
  149. TYPE
  150.     AGErr                                = SInt16;
  151. {  Apple Guide error codes }
  152.  
  153. CONST
  154.                                                                 {  -------------------- Apple event reply codes }
  155.     kAGErrUnknownEvent            = -2900;
  156.     kAGErrCantStartup            = -2901;
  157.     kAGErrNoAccWin                = -2902;
  158.     kAGErrNoPreWin                = -2903;
  159.     kAGErrNoSequence            = -2904;
  160.     kAGErrNotOopsSequence        = -2905;
  161.     kAGErrReserved06            = -2906;
  162.     kAGErrNoPanel                = -2907;
  163.     kAGErrContentNotFound        = -2908;
  164.     kAGErrMissingString            = -2909;
  165.     kAGErrInfoNotAvail            = -2910;
  166.     kAGErrEventNotAvailable        = -2911;
  167.     kAGErrCannotMakeCoach        = -2912;
  168.     kAGErrSessionIDsNotMatch    = -2913;
  169.     kAGErrMissingDatabaseSpec    = -2914;                        {  -------------------- Coach's Chalkboard reply codes }
  170.     kAGErrItemNotFound            = -2925;
  171.     kAGErrBalloonResourceNotFound = -2926;
  172.     kAGErrChalkResourceNotFound    = -2927;
  173.     kAGErrChdvResourceNotFound    = -2928;
  174.     kAGErrAlreadyShowing        = -2929;
  175.     kAGErrBalloonResourceSkip    = -2930;
  176.     kAGErrItemNotVisible        = -2931;
  177.     kAGErrReserved32            = -2932;
  178.     kAGErrNotFrontProcess        = -2933;
  179.     kAGErrMacroResourceNotFound    = -2934;                        {  -------------------- API reply codes }
  180.     kAGErrAppleGuideNotAvailable = -2951;
  181.     kAGErrCannotInitCoach        = -2952;
  182.     kAGErrCannotInitContext        = -2953;
  183.     kAGErrCannotOpenAliasFile    = -2954;
  184.     kAGErrNoAliasResource        = -2955;
  185.     kAGErrDatabaseNotAvailable    = -2956;
  186.     kAGErrDatabaseNotOpen        = -2957;
  187.     kAGErrMissingAppInfoHdl        = -2958;
  188.     kAGErrMissingContextObject    = -2959;
  189.     kAGErrInvalidRefNum            = -2960;
  190.     kAGErrDatabaseOpen            = -2961;
  191.     kAGErrInsufficientMemory    = -2962;
  192.  
  193. {  Events }
  194.  
  195. {  Not an enum because we want to make assignments. }
  196.  
  197. TYPE
  198.     AGEvent                                = UInt32;
  199. {  Handy events for AGGeneral. }
  200.  
  201. CONST
  202.                                                                 {  Panel actions (Require a presentation window). }
  203.     kAGEventDoCoach                = 'doco';
  204.     kAGEventDoHuh                = 'dhuh';
  205.     kAGEventGoNext                = 'gonp';
  206.     kAGEventGoPrev                = 'gopp';
  207.     kAGEventHidePanel            = 'pahi';
  208.     kAGEventReturnBack            = 'gobk';
  209.     kAGEventShowPanel            = 'pash';
  210.     kAGEventTogglePanel            = 'patg';
  211.  
  212. {  Functions }
  213.  
  214. {
  215.    AGClose
  216.    Close the database associated with the AGRefNum.
  217. }
  218.  
  219. FUNCTION AGClose(VAR refNum: AGRefNum): AGErr;
  220.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  221.     INLINE $7011, $AA6E;
  222.     {$ENDC}
  223. {
  224.    AGGeneral
  225.    Cause various events to happen.
  226. }
  227.  
  228. FUNCTION AGGeneral(refNum: AGRefNum; theEvent: AGEvent): AGErr;
  229.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  230.     INLINE $700D, $AA6E;
  231.     {$ENDC}
  232. {
  233.    AGGetAvailableDBTypes
  234.    Return the database types available for this application.
  235. }
  236.  
  237. FUNCTION AGGetAvailableDBTypes: UInt32;
  238.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  239.     INLINE $7008, $AA6E;
  240.     {$ENDC}
  241. {
  242.    AGGetFrontWindowKind
  243.    Return the kind of the front window.
  244. }
  245.  
  246. FUNCTION AGGetFrontWindowKind(refNum: AGRefNum): AGWindowKind;
  247.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  248.     INLINE $700C, $AA6E;
  249.     {$ENDC}
  250. {
  251.    AGGetFSSpec
  252.    Return the FSSpec for the AGRefNum.
  253. }
  254.  
  255. FUNCTION AGGetFSSpec(refNum: AGRefNum; VAR fileSpec: FSSpec): AGErr;
  256.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  257.     INLINE $700F, $AA6E;
  258.     {$ENDC}
  259. {
  260.    AGGetStatus
  261.    Return the status of Apple Guide.
  262. }
  263.  
  264. FUNCTION AGGetStatus: AGStatus;
  265.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  266.     INLINE $7009, $AA6E;
  267.     {$ENDC}
  268. {
  269.    AGInstallCoachHandler
  270.    Install a Coach object location query handler.
  271. }
  272.  
  273. FUNCTION AGInstallCoachHandler(coachReplyProc: CoachReplyUPP; refCon: LONGINT; VAR resultRefNum: AGCoachRefNum): AGErr;
  274.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  275.     INLINE $7012, $AA6E;
  276.     {$ENDC}
  277. {
  278.    AGInstallContextHandler
  279.    Install a context check query handler.
  280. }
  281.  
  282. FUNCTION AGInstallContextHandler(contextReplyProc: ContextReplyUPP; eventID: AEEventID; refCon: LONGINT; VAR resultRefNum: AGContextRefNum): AGErr;
  283.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  284.     INLINE $7013, $AA6E;
  285.     {$ENDC}
  286. {
  287.    AGIsDatabaseOpen
  288.    Return true if the database associated with the AGRefNum is open.
  289. }
  290.  
  291. FUNCTION AGIsDatabaseOpen(refNum: AGRefNum): BOOLEAN;
  292.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  293.     INLINE $7006, $AA6E;
  294.     {$ENDC}
  295. {
  296.    AGOpen
  297.    Open a guide database.
  298. }
  299.  
  300. FUNCTION AGOpen(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; VAR resultRefNum: AGRefNum): AGErr;
  301.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  302.     INLINE $7001, $AA6E;
  303.     {$ENDC}
  304. {
  305.    AGOpenWithSearch
  306.    Open a guide database and preset a search string.
  307. }
  308.  
  309. FUNCTION AGOpenWithSearch(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; searchString: ConstStr255Param; VAR resultRefNum: AGRefNum): AGErr;
  310.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  311.     INLINE $7002, $AA6E;
  312.     {$ENDC}
  313. {
  314.    AGOpenWithSequence
  315.    Open a guide database and display a presentation window sequence.
  316. }
  317.  
  318. FUNCTION AGOpenWithSequence(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; sequenceID: INTEGER; VAR resultRefNum: AGRefNum): AGErr;
  319.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  320.     INLINE $7004, $AA6E;
  321.     {$ENDC}
  322. {
  323.    AGOpenWithView
  324.    Open a guide database and override the default view.
  325. }
  326.  
  327. FUNCTION AGOpenWithView(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; viewNum: INTEGER; VAR resultRefNum: AGRefNum): AGErr;
  328.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  329.     INLINE $7005, $AA6E;
  330.     {$ENDC}
  331. {
  332.    AGQuit
  333.    Make Apple Guide quit.
  334. }
  335.  
  336. FUNCTION AGQuit: AGErr;
  337.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  338.     INLINE $7010, $AA6E;
  339.     {$ENDC}
  340. {
  341.    AGRemoveCoachHandler
  342.    Remove the Coach object location query handler.
  343. }
  344.  
  345. FUNCTION AGRemoveCoachHandler(VAR resultRefNum: AGCoachRefNum): AGErr;
  346.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  347.     INLINE $7014, $AA6E;
  348.     {$ENDC}
  349. {
  350.    AGRemoveContextHandler
  351.    Remove the context check query handler.
  352. }
  353.  
  354. FUNCTION AGRemoveContextHandler(VAR resultRefNum: AGContextRefNum): AGErr;
  355.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  356.     INLINE $7015, $AA6E;
  357.     {$ENDC}
  358. {
  359.    AGStart
  360.    Start up Apple Guide in the background.
  361. }
  362.  
  363. FUNCTION AGStart: AGErr;
  364.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  365.     INLINE $700A, $AA6E;
  366.     {$ENDC}
  367.  
  368. {$ALIGN RESET}
  369. {$POP}
  370.  
  371. {$SETC UsingIncludes := AppleGuideIncludes}
  372.  
  373. {$ENDC} {__APPLEGUIDE__}
  374.  
  375. {$IFC NOT UsingIncludes}
  376.  END.
  377. {$ENDC}
  378.